Release notes

• simple history cmds (simple history cmds #2)
• Add gapminder example (Add gapminder example #10)
• Add Gapminder Tracking (Add Gapminder Tracking #14)
• Connect Gapminder to retrieval index (Connect Gapminder to retrieval index #15)
• Add world map (Add world map #17)
• fix Add login and provenance menu to header #18 provenance graph menu (fix #18 provenance graph menu #20)
• Replace CLUE tracking with @VisualStorytelling/provenance-core (Replace CLUE tracking with @VisualStorytelling/provenance-core  #21)
• Use npm-force-resolutions (Use npm-force-resolutions #22)
• Update node-sass to ^4.12.0 (Update node-sass to ^4.12.0 #25)
• Update phovea plugin files (Update phovea plugin files #27)
• Update template files and dependencies (Update template files and dependencies #28)
• Remove and ignore package-lock.json (Remove and ignore package-lock.json #29)
• Update to Python 3.7 (Update to Python 3.7 #30)
• add CODEOWNERS file (add CODEOWNERS file #31)
• Migrate to jest for testing (Migrate to jest for testing #32)
• Update to Typescript 3.8 (Update to Typescript 3.8 #34)
• Update dependencies (Update dependencies #37)
• Change buildId to JSON.stringify(buildId) (Change buildId to JSON.stringify(buildId) #39)
• Update homepage (Update homepage #44)
• Update README.md circleci links (Update README.md circleci links #45)
• Update README.md (Update README.md #46)
• Update .gitattributes (Update .gitattributes #47)
• Refactor stylesheets organization and imports (Refactor stylesheets organization and imports #49)
• Upgrade to Font Awesome v5 (Upgrade to Font Awesome v5 #50)
• Update requirements and dependencies (Update requirements and dependencies #52)
• Add 500.html and 404.html to the app (Add 500.html and 404.html to the app #54)

Checklists

Release preparation

• Create new release-x.x.x branch (based on develop branch)
• Collect changes and write release notes
• Draft release PR in GitHub that merges the release-x.x.x into the master branch

Release dependencies first

In case of dependent Phovea/TDP repositories follow dependency tree from the top:

• Release dependent repositories if they contain changes first before proceeding here
• Replace git dependencies in package.json with new version range (e.g., "phovea_core": "^2.3.1" when published on npm or "phovea_core": "github:datavisyn/tdp_core#semver:^8.0.0" for non-published repositories)
• Commit and push new dependencies
• Wait until build is successful
• Repeat with other repositories/dependencies or proceed with next section

Update version

• Check version numbers of dependencies again
• Check if build is successful
• Update this version number following semver
• Commit and push package.json with new version number
• Assign reviewer and wait for final review
• Merge this pull request into master branch
• Add release label (i.e., release: major, release: minor, or release: patch)

Publish npm release

The steps of this section are only necessary if the code is public and should be published to the npm registry.

• chmod -R o+w . in the cloned repository directory (to provide write access to the CircleCI Linux user)
• rm -rf dist && rm -rf build && rm -rf node_modules/ && rm -rf package-lock.json
• docker run -it -v $(pwd):/phovea circleci/node:12.13-buster-browsers /bin/bash and continue inside the container
• cd /phovea
• npm install
• npm run build to build the bundles
• npm login as caleydo-bot
• npm publish
• Check release on npmjs.com

Create GitHub release

• Draft a new release (Code -> Releases -> Draft a new release)
• Use new version number as tag (e.g., v2.3.1)
• Copy release notes
• Publish release

Prepeare next develop release

• Switch to develop branch
• Merge master branch into develop (git merge origin/master)
• Update version in package.json to <next patch version>-SNAPSHOT (e.g., 2.3.1 to 2.3.2-SNAPSHOT)
• Revert dependencies in package.json to develop branches (e.g., "phovea_core": "github:phovea/phovea_core#develop")
• Commit and push changes

🏁 Finish line

• Inform colleagues and customers about the release
• Celebrate the new release 🥳